Developer --> Technical Publications
PATHHardware Documentation > USB Devices > Mac OS USB DDK API Reference


USBSetPipeIdleByReference

The USBSetPipeIdleByReference function sets a specified pipe to the idle state. This call can be used only on a specified pipe, not on a device's default pipe 0.

OSStatus USBSetPipeIdleByReference(USBPipeRef ref);

--> ref
Pipe reference.

The state of the pipe is set to idle. No outstanding transactions are affected.

Errors returned by the USBSetPipeIdleByReference function include:

kUSBUnknownPipeErr
-6997 pipe reference specified is unknown

In version 1.0 of the USB Services software, the following errors are returned if the pipe is not currently active. In these instances, the call has succeeded despite the returned error. This behavior is not an error and noErr is returned in versions 1.0.1 and later of the USB Services software.

kUSBPipeIdleStalled
-6979 pipe was stalled, pipe is still active despite error
kUSBPipeIdleErr
-6980 specified pipe is in the idle state

© 1999 Apple Computer, Inc.

Previous | Back Up One Level | Next | Show Frames | Hide Frames